{
"errors": [
{
"type": "parameters",
"message": "The supplied parameters are invalid."
}
]
}
{
"errors": [
{
"type": "not_found",
"message": "The server could not find the requested resource."
}
]
}
{
"errors": [
{
"type": "unable_to_process",
"message": "There was an error processing the request."
}
]
}
Authorizations
Authorization
string
header
required
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
id
integer<int32>
required
The id of the referenced Retailer.
Required range: x >= 1
Query Parameters
fields
enum<string>[]
Specify additional fields of the Retailer object to be included in the response.
See the selecting fields page for more information.
Available options:
basic,
all,
code,
name,
status,
fulfillment_model,
parent_retailer,
legal_name,
dba,
default_duties_payor,
default_shipping_method,
allowed_shipping_methods,
routing_guide_notes,
custom_fields,
created_at,
updated_at
fields:parent_retailer
enum<string>[]
Specify additional fields of the parent Retailer object to be included in the response. See the selecting fields page for more information.
Available options:
basic,
all,
code,
name,
status,
fulfillment_model,
parent_retailer,
legal_name,
dba,
default_duties_payor,
default_shipping_method,
allowed_shipping_methods,
routing_guide_notes,
custom_fields,
created_at,
updated_at
Response
OK
resource
Retailer · object
A Retailer represents a B2B retail partner shared by all merchants, including fulfillment defaults and retailer-specific custom fields.
Show child attributes
included
object
Lists of referenced objects included by specifying optional fields.
See the selecting fields page for more information.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"ShipStream Developer Center","colors":{"primary":"#2a81c4","light":"#2a81c4","dark":"#2a81c4"},"logo":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=b83b5ebc8570308bd06c53fdc32eb950","href":"https://shipstream.io"},"favicon":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=85c67af04fff1dac7f40844baf8c28d6","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=72f5d317204ffe6e66245125e71f9831"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:help@shipstream.io","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://shipstream.io"}},"footer":{"socials":{"github":"https://github.com/shipstream","linkedin":"https://linkedin.com/company/shipstream-llc"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shipstream","hasAudioNarration":false,"actualSubdomain":"shipstream","customDomains":["docs.shipstream.io"],"gitSource":{"type":"github","owner":"colinmollenhour","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false},"entitlements":{},"buildId":"6af4b45f5854fd9188278ee8","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Global API Reference","count":154},{"language":"default","tag":"Inventory API v1","count":95},{"language":"default","tag":"Shipping API v1","count":37},{"language":"default","tag":"Merchant API Reference","count":31},{"language":"default","tag":"Retailers","count":26},{"language":"default","tag":"Replenishment","count":14},{"language":"default","tag":"Slotting Rules","count":12},{"language":"default","tag":"System API v1","count":11},{"language":"default","tag":"Common Features","count":11},{"language":"default","tag":"Product Profiles","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"global-api/endpoint/v1/shipping/retailers/{id}/get","slug":"/global-api/endpoint/v1/shipping/retailers/{id}/get","pageMetadata":{"title":"Get one Retailer","openapi":"GET /v1/shipping/retailers/{id}","description":"Returns a single `Retailer` object specified by a retailer `id` path parameter.","href":"/global-api/endpoint/v1/shipping/retailers/{id}/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a single \", _jsx(_components.code, {\n children: \"Retailer\"\n }), \" object specified by a retailer \", _jsx(_components.code, {\n children: \"id\"\n }), \" path parameter.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get one Retailer","openapi":"GET /v1/shipping/retailers/{id}","description":"Returns a single `Retailer` object specified by a retailer `id` path parameter.","href":"/global-api/endpoint/v1/shipping/retailers/{id}/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get one Retailer","description":"Returns a single `Retailer` object specified by a retailer `id` path parameter.","tags":["Retailers"],"operationId":"getRetailer","parameters":["44f7b6c9-9fb7-435c-8e97-172e9a917032","fed45a5b-f2f1-48a0-9019-eff29cccf253","7ad0a272-ddb0-4e8b-a4f9-2d1c8b423821"],"responses":{"200":"38fccd06-e365-4df2-8604-bbac4a852b3b","400":"bed6f37a-68d1-41df-9c09-eafa813f5fef","404":"cd33fbe6-9d0c-4878-a715-18a387a1bef5","422":"5109bd75-3e2c-45a8-a999-b7252c3cdd61","500":"064b71e4-686b-44a9-8f7e-e916a4133a98"},"method":"get","type":"path","servers":["ef91e759-2c9e-49ec-94f7-67f00bef7855"],"security":["14e26847-ab2d-4b99-802e-ad8d28c9bde0"],"path":"/v1/shipping/retailers/{id}","baseUrlOptions":["https://{base_url_domain}/api/global"],"title":"Get one Retailer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"44f7b6c9-9fb7-435c-8e97-172e9a917032":{"name":"id","in":"path","schema":{"type":"integer","format":"int32","minimum":1,"isRequired":true,"description":"The `id` of the referenced `Retailer`.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"required":true,"description":"The `id` of the referenced `Retailer`."},"fed45a5b-f2f1-48a0-9019-eff29cccf253":{"name":"fields","in":"query","required":false,"description":"Specify additional fields of the `Retailer` object to be included in the response.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Retailer","type":"array","items":{"type":"string","enum":["basic","all","code","name","status","fulfillment_model","parent_retailer","legal_name","dba","default_duties_payor","default_shipping_method","allowed_shipping_methods","routing_guide_notes","custom_fields","created_at","updated_at"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `Retailer` object to be included in the response.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"7ad0a272-ddb0-4e8b-a4f9-2d1c8b423821":{"name":"fields:parent_retailer","in":"query","required":false,"description":"Specify additional fields of the parent `Retailer` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Retailer","type":"array","items":{"type":"string","enum":["basic","all","code","name","status","fulfillment_model","parent_retailer","legal_name","dba","default_duties_payor","default_shipping_method","allowed_shipping_methods","routing_guide_notes","custom_fields","created_at","updated_at"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the parent `Retailer` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}}},"responses":{"38fccd06-e365-4df2-8604-bbac4a852b3b":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"title":"Retailer","type":"object","description":"A `Retailer` represents a B2B retail partner shared by all merchants, including fulfillment defaults and retailer-specific custom fields.","properties":{"type":{"type":"string","enum":["Retailer"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","minimum":1,"example":123,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.id","typeLabel":"integer\u003cint32>"},"code":{"type":"string","minLength":1,"maxLength":64,"example":"walmart","description":"Globally unique retailer code.","uniqueKey":"resource.code","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":255,"example":"Walmart","description":"Retailer display name.","uniqueKey":"resource.name","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"default":"active","example":"active","description":"Retailer lifecycle status. Archived retailers are hidden from lists by default and cannot be assigned to new orders.","uniqueKey":"resource.status","typeLabel":"enum\u003cstring>"},"fulfillment_model":{"type":"string","enum":["wholesale","drop_ship","mixed"],"default":"wholesale","example":"wholesale","description":"Default fulfillment model used for this retailer.","uniqueKey":"resource.fulfillment_model","typeLabel":"enum\u003cstring>"},"parent_retailer":{"oneOf":[{"type":"object","title":"RetailerRef","description":"Optional parent retailer reference. Any non-archived retailer may serve as the parent.\\\n `Optional Field`","required":["type","id"],"properties":{"type":{"type":"string","enum":["Retailer"],"example":"Retailer","isRequired":true,"uniqueKey":"resource.parent_retailer.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","minimum":1,"example":2,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.parent_retailer.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.parent_retailer.oneOf.0","typeLabel":"RetailerRef · object"},{"type":"null","uniqueKey":"resource.parent_retailer.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.parent_retailer","typeLabel":"RetailerRef · object | null"},"legal_name":{"oneOf":[{"type":"string","maxLength":255,"example":"Walmart Inc.","description":"Legal retailer name.\\\n `Optional Field`","uniqueKey":"resource.legal_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"Walmart Inc.","description":"Legal retailer name.\\\n `Optional Field`","uniqueKey":"resource.legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.legal_name","typeLabel":"string | null"},"dba":{"oneOf":[{"type":"string","maxLength":255,"example":"Walmart Marketplace","description":"Doing-business-as name.\\\n `Optional Field`","uniqueKey":"resource.dba.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"Walmart Marketplace","description":"Doing-business-as name.\\\n `Optional Field`","uniqueKey":"resource.dba.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.dba","typeLabel":"string | null"},"default_duties_payor":{"oneOf":[{"type":"string","enum":["shipper","recipient","third_party"],"example":"recipient","description":"Default duties payor for order-integration defaults.\\\n `Optional Field`","uniqueKey":"resource.default_duties_payor.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["shipper","recipient","third_party"],"example":"recipient","description":"Default duties payor for order-integration defaults.\\\n `Optional Field`","uniqueKey":"resource.default_duties_payor.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.default_duties_payor","typeLabel":"enum\u003cstring> | null"},"default_shipping_method":{"oneOf":[{"type":"string","maxLength":255,"example":"fedex_FEDEX_GROUND","description":"Default shipping method for order-integration defaults.\\\n `Optional Field`","uniqueKey":"resource.default_shipping_method.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"fedex_FEDEX_GROUND","description":"Default shipping method for order-integration defaults.\\\n `Optional Field`","uniqueKey":"resource.default_shipping_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.default_shipping_method","typeLabel":"string | null"},"allowed_shipping_methods":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"resource.allowed_shipping_methods.oneOf.0.items.[INDEX]","typeLabel":"string"},"example":["fedex_FEDEX_GROUND","ups_GND"],"description":"Shipping methods allowed when this retailer is selected.\\\n `Optional Field`","uniqueKey":"resource.allowed_shipping_methods.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"example":["fedex_FEDEX_GROUND","ups_GND"],"description":"Shipping methods allowed when this retailer is selected.\\\n `Optional Field`","uniqueKey":"resource.allowed_shipping_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.allowed_shipping_methods","typeLabel":"string[] | null"},"routing_guide_notes":{"oneOf":[{"type":"string","maxLength":65535,"description":"Free-form routing-guide notes.\\\n `Optional Field`","uniqueKey":"resource.routing_guide_notes.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":65535,"description":"Free-form routing-guide notes.\\\n `Optional Field`","uniqueKey":"resource.routing_guide_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.routing_guide_notes","typeLabel":"string | null"},"custom_fields":{"oneOf":[{"type":"object","description":"Custom fields associated with the retailer in script format. Each field contains\na code and value, with additional properties depending on the field type.\\\n `Optional Field`","example":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}},"additionalProperties":{"oneOf":[{"type":"object","description":"Union type for all possible custom field value formats.","required":["value"],"properties":{"value":{"oneOf":[{"type":"boolean","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.1","typeLabel":"string"},{"type":"number","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.2","typeLabel":"number"},{"type":"integer","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.3","typeLabel":"integer"}],"isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"boolean | string | number | integer"}},"additionalProperties":false,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.1.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.1.currency","typeLabel":"string"}},"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.1","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.2","typeLabel":"null"},{"type":"object","description":"Union type for all possible custom field value formats.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.3.id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.3.label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"type":"object","description":"A selected option for select type fields.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"object"},"description":"Union type for all possible custom field value formats.","uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object[]"}],"uniqueKey":"resource.custom_fields.oneOf.0.additionalProperties","typeLabel":"object · Monetary · object · null · object · object[]"},"uniqueKey":"resource.custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"resource.custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.custom_fields","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","description":"The date and time the retailer was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"resource.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date and time the retailer was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"resource.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","description":"The date and time the retailer was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:39:43Z","uniqueKey":"resource.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date and time the retailer was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:39:43Z","uniqueKey":"resource.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource","typeLabel":"Retailer · object"},"included":{"type":"object","description":"Lists of referenced objects included by specifying optional fields.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","properties":{"Retailer":{"type":"array","items":{"title":"Retailer","type":"object","description":"A `Retailer` represents a B2B retail partner shared by all merchants, including fulfillment defaults and retailer-specific custom fields.","properties":{"type":{"type":"string","enum":["Retailer"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","minimum":1,"example":123,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"code":{"type":"string","minLength":1,"maxLength":64,"example":"walmart","description":"Globally unique retailer code.","uniqueKey":"included.Retailer.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":255,"example":"Walmart","description":"Retailer display name.","uniqueKey":"included.Retailer.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["active","archived"],"default":"active","example":"active","description":"Retailer lifecycle status. Archived retailers are hidden from lists by default and cannot be assigned to new orders.","uniqueKey":"included.Retailer.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"fulfillment_model":{"type":"string","enum":["wholesale","drop_ship","mixed"],"default":"wholesale","example":"wholesale","description":"Default fulfillment model used for this retailer.","uniqueKey":"included.Retailer.items.[INDEX].fulfillment_model","typeLabel":"enum\u003cstring>"},"parent_retailer":{"oneOf":[{"type":"object","title":"RetailerRef","description":"Optional parent retailer reference. Any non-archived retailer may serve as the parent.\\\n `Optional Field`","required":["type","id"],"properties":{"type":{"type":"string","enum":["Retailer"],"example":"Retailer","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].parent_retailer.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","minimum":1,"example":2,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].parent_retailer.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Retailer.items.[INDEX].parent_retailer.oneOf.0","typeLabel":"RetailerRef · object"},{"type":"null","uniqueKey":"included.Retailer.items.[INDEX].parent_retailer.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].parent_retailer","typeLabel":"RetailerRef · object | null"},"legal_name":{"oneOf":[{"type":"string","maxLength":255,"example":"Walmart Inc.","description":"Legal retailer name.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].legal_name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"Walmart Inc.","description":"Legal retailer name.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].legal_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].legal_name","typeLabel":"string | null"},"dba":{"oneOf":[{"type":"string","maxLength":255,"example":"Walmart Marketplace","description":"Doing-business-as name.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].dba.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"Walmart Marketplace","description":"Doing-business-as name.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].dba.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].dba","typeLabel":"string | null"},"default_duties_payor":{"oneOf":[{"type":"string","enum":["shipper","recipient","third_party"],"example":"recipient","description":"Default duties payor for order-integration defaults.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].default_duties_payor.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["shipper","recipient","third_party"],"example":"recipient","description":"Default duties payor for order-integration defaults.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].default_duties_payor.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].default_duties_payor","typeLabel":"enum\u003cstring> | null"},"default_shipping_method":{"oneOf":[{"type":"string","maxLength":255,"example":"fedex_FEDEX_GROUND","description":"Default shipping method for order-integration defaults.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].default_shipping_method.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"example":"fedex_FEDEX_GROUND","description":"Default shipping method for order-integration defaults.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].default_shipping_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].default_shipping_method","typeLabel":"string | null"},"allowed_shipping_methods":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"included.Retailer.items.[INDEX].allowed_shipping_methods.oneOf.0.items.[INDEX]","typeLabel":"string"},"example":["fedex_FEDEX_GROUND","ups_GND"],"description":"Shipping methods allowed when this retailer is selected.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].allowed_shipping_methods.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"example":["fedex_FEDEX_GROUND","ups_GND"],"description":"Shipping methods allowed when this retailer is selected.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].allowed_shipping_methods.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].allowed_shipping_methods","typeLabel":"string[] | null"},"routing_guide_notes":{"oneOf":[{"type":"string","maxLength":65535,"description":"Free-form routing-guide notes.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].routing_guide_notes.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":65535,"description":"Free-form routing-guide notes.\\\n `Optional Field`","uniqueKey":"included.Retailer.items.[INDEX].routing_guide_notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].routing_guide_notes","typeLabel":"string | null"},"custom_fields":{"oneOf":[{"type":"object","description":"Custom fields associated with the retailer in script format. Each field contains\na code and value, with additional properties depending on the field type.\\\n `Optional Field`","example":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}},"additionalProperties":{"oneOf":[{"type":"object","description":"Union type for all possible custom field value formats.","required":["value"],"properties":{"value":{"oneOf":[{"type":"boolean","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.1","typeLabel":"string"},{"type":"number","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.2","typeLabel":"number"},{"type":"integer","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.3","typeLabel":"integer"}],"isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"boolean | string | number | integer"}},"additionalProperties":false,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1.currency","typeLabel":"string"}},"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.2","typeLabel":"null"},{"type":"object","description":"Union type for all possible custom field value formats.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3.id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3.label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"type":"object","description":"A selected option for select type fields.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"object"},"description":"Union type for all possible custom field value formats.","uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object[]"}],"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0.additionalProperties","typeLabel":"object · Monetary · object · null · object · object[]"},"uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"included.Retailer.items.[INDEX].custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].custom_fields","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","description":"The date and time the retailer was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"included.Retailer.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date and time the retailer was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"included.Retailer.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","description":"The date and time the retailer was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:39:43Z","uniqueKey":"included.Retailer.items.[INDEX].updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date and time the retailer was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","format":"date-time","example":"2017-07-21T17:39:43Z","uniqueKey":"included.Retailer.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Retailer.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Retailer.items.[INDEX]","typeLabel":"Retailer · object"},"uniqueKey":"included.Retailer","typeLabel":"Retailer · object[]"}},"uniqueKey":"included","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"resource":{"type":"Retailer","id":123,"code":"walmart","name":"Walmart","status":"active","fulfillment_model":"wholesale","parent_retailer":{"type":"Retailer","id":2},"legal_name":"Walmart Inc.","dba":"Walmart Marketplace","default_duties_payor":"recipient","default_shipping_method":"fedex_FEDEX_GROUND","allowed_shipping_methods":["fedex_FEDEX_GROUND","ups_GND"],"routing_guide_notes":"\u003cstring>","custom_fields":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}},"created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z"},"included":{"Retailer":[{"type":"Retailer","id":123,"code":"walmart","name":"Walmart","status":"active","fulfillment_model":"wholesale","parent_retailer":{"type":"Retailer","id":2},"legal_name":"Walmart Inc.","dba":"Walmart Marketplace","default_duties_payor":"recipient","default_shipping_method":"fedex_FEDEX_GROUND","allowed_shipping_methods":["fedex_FEDEX_GROUND","ups_GND"],"routing_guide_notes":"\u003cstring>","custom_fields":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}},"created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"bed6f37a-68d1-41df-9c09-eafa813f5fef":{"description":"The request was invalid. The client must change the request. See the response body for more details.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["parser","parameters","openapi"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"cd33fbe6-9d0c-4878-a715-18a387a1bef5":{"description":"The requested resource was not found. It may have been deleted, it may have never existed, or you may not have permission to view it.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["not_found"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"5109bd75-3e2c-45a8-a999-b7252c3cdd61":{"description":"There was an error processing the request. See the response body for more details.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["application","unable_to_process"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"unable_to_process","message":"There was an error processing the request."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"unable_to_process","message":"There was an error processing the request."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"064b71e4-686b-44a9-8f7e-e916a4133a98":{"description":"Internal Server Error - Something wrong happened at server side. Contact server administrator for more details.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"14e26847-ab2d-4b99-802e-ad8d28c9bde0":{"ShipStream_bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","scopes":[],"schemeName":"ShipStream_bearerAuth"}}},"servers":{"ef91e759-2c9e-49ec-94f7-67f00bef7855":{"url":"https://{base_url_domain}/api/global","description":"Direct API Url","variables":{"base_url_domain":{"default":"example.shipstream.app","description":"The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app,\nand will be the same as the domain name for the page which you use to login to ShipStream WMS."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","scopes":[],"schemeName":"ShipStream_bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ShipStream_bearerAuth","name":"Authorization"}],"title":"ShipStream_bearerAuth"}]},"originalFileLocation":"global-api/openapi.json"},"subdomain":"shipstream","siteName":"ShipStream Developer Center","title":"Get one Retailer - ShipStream Developer Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-29T22:16:12.205Z","originalFileLocation":"global-api/endpoint/v1/shipping/retailers/{id}/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a single Retailer object specified by a retailer id path parameter.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get one Retailer - ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single Retailer object specified by a retailer id path parameter.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/{id}/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shipstream.mintlify.site/_mintlify/api/og/v2?division=Retailers\u0026amp;title=Get+one+Retailer\u0026amp;description=Returns+a+single+%60Retailer%60+object+specified+by+a+retailer+%60id%60+path+parameter.\u0026amp;theme=00eab2ec1c104425773ad3b0\u0026amp;signature=a30c2a7fc9fc36faf43c31bbb46594e649d85b49d38ecb822199fc4fa49b9d66\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get one Retailer - ShipStream Developer Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single Retailer object specified by a retailer id path parameter.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shipstream.mintlify.site/_mintlify/api/og/v2?division=Retailers\u0026amp;title=Get+one+Retailer\u0026amp;description=Returns+a+single+%60Retailer%60+object+specified+by+a+retailer+%60id%60+path+parameter.\u0026amp;theme=00eab2ec1c104425773ad3b0\u0026amp;signature=a30c2a7fc9fc36faf43c31bbb46594e649d85b49d38ecb822199fc4fa49b9d66\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2a81c4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/{id}/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shipstream.io/#organization\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shipstream.io#website\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get#webpage\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get\",\"name\":\"Get one Retailer\",\"description\":\"Returns a single Retailer object specified by a retailer id path parameter.\",\"dateModified\":\"2026-06-29T22:16:12.205Z\",\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shipping API v1\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/shipments/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retailers\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get one Retailer\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get#apireference\",\"headline\":\"Get one Retailer\",\"name\":\"Get one Retailer\",\"description\":\"Returns a single Retailer object specified by a retailer id path parameter.\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get#webpage\"},\"dateModified\":\"2026-06-29T22:16:12.205Z\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ShipStream Developer Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ShipStream Developer Center\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/global-api/endpoint/v1/shipping/retailers/%7Bid%7D/get.md","siteName":"ShipStream Developer Center","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Global API Reference","groups":[{"group":"Get Started","pages":[{"title":"Introduction","mode":"wide","href":"/global-api/introduction"},{"title":"Authentication","href":"/global-api/authentication"},{"title":"Versions","href":"/global-api/versions"}]},{"group":"Common Features","pages":[{"title":"Paging Parameters","href":"/global-api/paging-parameters"},{"title":"Sorting Syntax","href":"/global-api/sorting-syntax"},{"title":"Filtering Syntax","href":"/global-api/filtering-syntax"},{"title":"Selecting Fields","href":"/global-api/selecting-fields"},{"title":"Response Codes and Errors","href":"/global-api/response-codes-errors"}]},{"group":"Inventory API v1","pages":[{"group":"Warehouses","pages":[{"title":"List all Warehouses","openapi":"GET /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/get"},{"title":"Create Warehouse","openapi":"POST /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/post"},{"title":"Get one Warehouse","openapi":"GET /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/get"},{"title":"Update Warehouse","openapi":"PUT /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/put"},{"title":"Delete Warehouse","openapi":"DELETE /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/delete"}]},{"group":"Locations","pages":[{"title":"List all Locations","openapi":"GET /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/get"},{"title":"Create Location","openapi":"POST /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/post"},{"title":"Get one Location","openapi":"GET /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/get"},{"title":"Update Location","openapi":"PUT /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/put"},{"title":"Delete Location","openapi":"DELETE /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/delete"},{"title":"Get Location by Label","openapi":"GET /v1/inventory/warehouses/{id}/locationsByLabel/{label}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get"},{"title":"Batch update Locations","openapi":"POST /v1/inventory/warehouses/{id}/locations/batch","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/batch/post"},{"title":"Batch Update Location Tags","openapi":"POST /v1/inventory/warehouses/{id}/locations/tags","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/tags/post"}]},{"group":"Location Tags","pages":[{"title":"List Location Tags","openapi":"GET /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/get"},{"title":"Create Location Tag","openapi":"POST /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/post"},{"title":"Get one Location Tag","openapi":"GET /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/get"},{"title":"Update Location Tag","openapi":"PUT /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/put"},{"title":"Delete Location Tag","openapi":"DELETE /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/delete"}]},{"group":"Slot Types","pages":[{"title":"List Slot Types","openapi":"GET /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/get"},{"title":"Create Slot Type","openapi":"POST /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/post"},{"title":"Get one Slot Type","openapi":"GET /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/get"},{"title":"Update Slot Type","openapi":"PUT /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/put"},{"title":"Delete Slot Type","openapi":"DELETE /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/delete"}]},{"group":"Location Profiles","pages":[{"title":"List Location Profiles","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/get"},{"title":"Create Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/post"},{"title":"Get Location Profile","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/get"},{"title":"Update Location Profile","openapi":"PUT /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/put"},{"title":"Delete Location Profile","openapi":"DELETE /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/delete"},{"title":"List Location Profile member Locations","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations/get"},{"title":"Rebuild Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild/post"}]},{"group":"Products","pages":[{"title":"List all Products and Packaging","openapi":"GET /v1/inventory/products/{type}","href":"/global-api/endpoint/v1/inventory/products/{type}/get"},{"title":"Get Product or Packaging","openapi":"GET /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/get"},{"title":"Update Product or Packaging","openapi":"PUT /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/put"},{"title":"Create Product or Packaging","openapi":"POST /v1/inventory/products","href":"/global-api/endpoint/v1/inventory/products/post"},{"title":"Get Product Classifications","openapi":"GET /v1/inventory/products/{type}/{id}/classifications","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/classifications/get"}]},{"group":"Product Profiles","pages":[{"title":"Editing Product Profile Conditions","href":"/global-api/product-profile-conditions"},{"title":"List Product Profiles","openapi":"GET /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/get"},{"title":"Create Product Profile","openapi":"POST /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/post"},{"title":"List Product Profile condition fields","openapi":"GET /v1/inventory/product-profiles/condition-fields","href":"/global-api/endpoint/v1/inventory/product-profiles/condition-fields/get"},{"title":"Get Product Profile by code","openapi":"GET /v1/inventory/product-profiles/by-code/{code}","href":"/global-api/endpoint/v1/inventory/product-profiles/by-code/{code}/get"},{"title":"Get Product Profile","openapi":"GET /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/get"},{"title":"Update Product Profile","openapi":"PUT /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/put"},{"title":"Delete Product Profile","openapi":"DELETE /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/delete"},{"title":"List Product Profile member Products","openapi":"GET /v1/inventory/product-profiles/{id}/products","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/products/get"},{"title":"List Product condition values","openapi":"GET /v1/inventory/product-condition-values","href":"/global-api/endpoint/v1/inventory/product-condition-values/get"}]},{"group":"Handling Classes","pages":[{"title":"Editing Handling Class Conditions","href":"/global-api/handling-class-conditions"},{"title":"List Handling Classes","openapi":"GET /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/get"},{"title":"Create Handling Class","openapi":"POST /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/post"},{"title":"List Handling Class condition fields","openapi":"GET /v1/inventory/handling-classes/condition-fields","href":"/global-api/endpoint/v1/inventory/handling-classes/condition-fields/get"},{"title":"Get Handling Class by code","openapi":"GET /v1/inventory/handling-classes/by-code/{code}","href":"/global-api/endpoint/v1/inventory/handling-classes/by-code/{code}/get"},{"title":"Get Handling Class","openapi":"GET /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/get"},{"title":"Update Handling Class","openapi":"PUT /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/put"},{"title":"Delete Handling Class","openapi":"DELETE /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/delete"}]},{"group":"Slotting Rules","pages":[{"title":"List Slotting Rule Sets","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/get"},{"title":"Create Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/post"},{"title":"Get Slotting Rule Set","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/get"},{"title":"Update Slotting Rule Set","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/put"},{"title":"Delete Slotting Rule Set","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/delete"},{"title":"Duplicate Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate/post"},{"title":"List Slotting Rules","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/get"},{"title":"Create Slotting Rule","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/post"},{"title":"Get Slotting Rule","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/get"},{"title":"Update Slotting Rule","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/put"},{"title":"Delete Slotting Rule","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/delete"},{"title":"List Slotting Conflicts","openapi":"GET /v1/inventory/warehouses/{id}/slotting-conflicts","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-conflicts/get"}]},{"group":"Replenishment","pages":[{"title":"List Policies","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/get"},{"title":"Create Policy","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/post"},{"title":"List Policy Options","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/options","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/options/get"},{"title":"Get Policy","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/get"},{"title":"Update Policy","openapi":"PUT /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/put"},{"title":"Delete Policy","openapi":"DELETE /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/delete"},{"title":"List Report Rows","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-report","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-report/get"},{"title":"Get Replenishment Index Status","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-index/status","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/status/get"},{"title":"Rebuild Replenishment Index","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-index/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/rebuild/post"},{"title":"List Replenishment Tasks","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-tasks","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-tasks/get"},{"title":"Create Replenishment Task","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-tasks","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-tasks/post"},{"title":"Get Replenishment Task Health","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-tasks/health","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-tasks/health/get"},{"title":"Get Replenishment Task","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-tasks/{task_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-tasks/{task_id}/get"},{"title":"Cancel Replenishment Task","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-tasks/{task_id}/cancel","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-tasks/{task_id}/cancel/post"}]},{"group":"Levels","pages":[{"title":"List total inventory levels","openapi":"GET /v1/inventory/levels/total","href":"/global-api/endpoint/v1/inventory/levels/total/get"},{"title":"List warehouse inventory levels","openapi":"GET /v1/inventory/levels/warehouse","href":"/global-api/endpoint/v1/inventory/levels/warehouse/get"}]},{"group":"HoldReasons","pages":[{"title":"List active hold reasons","openapi":"GET /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/get"},{"title":"Create user-defined hold reason","openapi":"POST /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/post"},{"title":"Update hold reason","openapi":"PUT /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/put"},{"title":"Delete user-defined hold reason","openapi":"DELETE /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/delete"}]},{"group":"Holds","pages":[{"title":"List / search inventory holds","openapi":"GET /v1/inventory/holds","href":"/global-api/endpoint/v1/inventory/holds/get"},{"title":"Get one Hold by ID","openapi":"GET /v1/inventory/holds/{id}","href":"/global-api/endpoint/v1/inventory/holds/{id}/get"},{"title":"Place location-level Hold","openapi":"POST /v1/inventory/holds/location","href":"/global-api/endpoint/v1/inventory/holds/location/post"},{"title":"Place lot-level Hold (with optional BOM cascade)","openapi":"POST /v1/inventory/holds/lot","href":"/global-api/endpoint/v1/inventory/holds/lot/post"},{"title":"Release one Hold by ID","openapi":"POST /v1/inventory/holds/{id}/release","href":"/global-api/endpoint/v1/inventory/holds/{id}/release/post"},{"title":"Release eligible Holds on Lot","openapi":"POST /v1/inventory/holds/lot/{lot_id}/release","href":"/global-api/endpoint/v1/inventory/holds/lot/{lot_id}/release/post"},{"title":"Get quarantine state of Lot","openapi":"GET /v1/inventory/holds/lot/{lot_id}","href":"/global-api/endpoint/v1/inventory/holds/lot/{lot_id}/get"},{"title":"Release related Lots still quarantined with Lot","openapi":"POST /v1/inventory/holds/lot/{lot_id}/release-related-lots","href":"/global-api/endpoint/v1/inventory/holds/lot/{lot_id}/release-related-lots/post"}]},{"group":"Location Occupancies","pages":[{"title":"List Location Occupancies","openapi":"GET /v1/inventory/warehouses/{id}/location-occupancies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-occupancies/get"},{"title":"Get Location Occupancy","openapi":"GET /v1/inventory/warehouses/{id}/location-occupancies/{occupancy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-occupancies/{occupancy_id}/get"}]}]},{"group":"Receiving API v1","pages":[{"group":"Deliveries","pages":[{"title":"List all Deliveries","openapi":"GET /v1/receiving/{type}","href":"/global-api/endpoint/v1/receiving/{type}/get"},{"title":"Get one Delivery","openapi":"GET /v1/receiving/{type}/{id}","href":"/global-api/endpoint/v1/receiving/{type}/{id}/get"}]}]},{"group":"Shipping API v1","pages":[{"group":"Shipments","pages":[{"title":"List all Shipments","openapi":"GET /v1/shipping/shipments","href":"/global-api/endpoint/v1/shipping/shipments/get"},{"title":"Get one Shipment","openapi":"GET /v1/shipping/shipments/{id}","href":"/global-api/endpoint/v1/shipping/shipments/{id}/get"},{"title":"Process Shipment","openapi":"POST /v1/shipping/shipments/{id}/process","href":"/global-api/endpoint/v1/shipping/shipments/{id}/process/post"},{"title":"Pick Shipment","openapi":"POST /v1/shipping/shipments/{id}/pick","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pick/post"},{"title":"Pack Shipment","openapi":"POST /v1/shipping/shipments/{id}/pack","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pack/post"},{"title":"Mark Shipment as Shipped","openapi":"POST /v1/shipping/shipments/{id}/shipped","href":"/global-api/endpoint/v1/shipping/shipments/{id}/shipped/post"},{"title":"Get Shipment Reservations","openapi":"GET /v1/shipping/shipments/{id}/reservations","href":"/global-api/endpoint/v1/shipping/shipments/{id}/reservations/get"}]},{"group":"Orders","pages":[{"title":"Mass update orders","openapi":"POST /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/post"},{"title":"List all Orders","openapi":"GET /v1/shipping/orders","href":"/global-api/endpoint/v1/shipping/orders/get"},{"title":"Get one Order","openapi":"GET /v1/shipping/orders/{id}","href":"/global-api/endpoint/v1/shipping/orders/{id}/get"},{"title":"Method not allowed","openapi":"GET /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/get"}]},{"group":"Retailers","pages":[{"title":"List all Retailers","openapi":"GET /v1/shipping/retailers","href":"/global-api/endpoint/v1/shipping/retailers/get"},{"title":"Create Retailer","openapi":"POST /v1/shipping/retailers","description":"Creates a new `Retailer`.","href":"/global-api/endpoint/v1/shipping/retailers/post"},{"title":"Get one Retailer","openapi":"GET /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/get"},{"title":"Update Retailer","openapi":"PUT /v1/shipping/retailers/{id}","description":"Updates a `Retailer` specified by its `id` path parameter and according to the request body.","href":"/global-api/endpoint/v1/shipping/retailers/{id}/put"},{"title":"Delete Retailer","openapi":"DELETE /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/delete"},{"title":"List Retailer Identifiers","openapi":"GET /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/get"},{"title":"Create Retailer Identifier","openapi":"POST /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/post"},{"title":"Get one Retailer Identifier","openapi":"GET /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/get"},{"title":"Update Retailer Identifier","openapi":"PUT /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/put"},{"title":"Delete Retailer Identifier","openapi":"DELETE /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/delete"},{"title":"List Retailer Ship-To Locations","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/get"},{"title":"Create Retailer Ship-To Location","openapi":"POST /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/post"},{"title":"Get one Retailer Ship-To Location","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/get"},{"title":"Update Retailer Ship-To Location","openapi":"PUT /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/put"},{"title":"Delete Retailer Ship-To Location","openapi":"DELETE /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/delete"},{"title":"List Retailer Routing Guides","openapi":"GET /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/get"},{"title":"Create Retailer Routing Guide","openapi":"POST /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/post"},{"title":"Get one Retailer Routing Guide","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/get"},{"title":"Update Retailer Routing Guide metadata","openapi":"PUT /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/put"},{"title":"Delete Retailer Routing Guide","openapi":"DELETE /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/delete"},{"title":"Get Retailer Routing Guide file content","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}/file","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/file/get"},{"title":"List Retailer Merchant Settings","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/get"},{"title":"Create Retailer Merchant Setting","openapi":"POST /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/post"},{"title":"Get one Retailer Merchant Setting","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/get"},{"title":"Update Retailer Merchant Setting","openapi":"PUT /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/put"},{"title":"Delete Retailer Merchant Setting","openapi":"DELETE /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/delete"}]}]},{"group":"Operations API v1","pages":[{"group":"Picking Batches","pages":[{"title":"Create picking batch","openapi":"POST /v1/operations/picking-batches","href":"/global-api/endpoint/v1/operations/picking-batches/post"}]}]},{"group":"System API v1","pages":[{"group":"Merchants","pages":[{"title":"List all Merchants","openapi":"GET /v1/system/merchants","href":"/global-api/endpoint/v1/system/merchants/get"}]},{"group":"Users","pages":[{"title":"List all Users","openapi":"GET /v1/system/users/{type}","href":"/global-api/endpoint/v1/system/users/{type}/get"},{"title":"Get one User","openapi":"GET /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/get"},{"title":"Update one User","openapi":"PUT /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/put"},{"title":"Delete User","openapi":"DELETE /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/delete"},{"title":"Send User password reset link","openapi":"POST /v1/system/users/{type}/{id}/reset-password","href":"/global-api/endpoint/v1/system/users/{type}/{id}/reset-password/post"}]},{"group":"User Roles","pages":[{"title":"List all User Roles","openapi":"GET /v1/system/userRoles/{type}","href":"/global-api/endpoint/v1/system/userRoles/{type}/get"},{"title":"Get one User Role","openapi":"GET /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/get"},{"title":"Update one User Role","openapi":"PUT /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/put"},{"title":"Delete User Role","openapi":"DELETE /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/delete"}]},{"group":"Healthcheck","pages":[{"title":"Healthcheck","openapi":"GET /v1/system/status","href":"/global-api/endpoint/v1/system/status/get"}]}]}]},{"tab":"Merchant API Reference","pages":[{"title":"Merchant API Reference","href":"/merchant-api/introduction"}]}]},"basePath":"","title":"Get one Retailer - ShipStream Developer Center","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}